-
Notifications
You must be signed in to change notification settings - Fork 19.9k
refactor: split changes for api/.ruff.toml , after merging all of #29289 part, merge this. #29872
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
refactor: split changes for api/.ruff.toml , after merging all of #29289 part, merge this. #29872
Conversation
Summary of ChangesHello @asukaminato0721, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request refactors the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the Ruff configuration to enforce the use of Pydantic models over flask_restx.reqparse. This is a positive change that promotes modern, type-safe data validation. The changes in .ruff.toml correctly enable the flake8-tidy-imports rules and configure it to ban reqparse. I have one suggestion to make the configuration more concise by removing a redundant rule.
|
|
||
| [lint.flake8-tidy-imports.banned-api."flask_restx.reqparse.RequestParser"] | ||
| msg = "Use Pydantic payload/query models instead of reqparse." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Banning the flask_restx.reqparse module on line 120 is sufficient to prevent its use, including any classes or functions within it like RequestParser. According to the Ruff documentation, banning a module will flag any import from or of that module. Therefore, this second rule for flask_restx.reqparse.RequestParser is redundant and can be removed for a cleaner configuration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds flake8-tidy-imports linting rules to the Ruff configuration, specifically to enforce the migration from flask_restx.reqparse to Pydantic models. This is intended to be merged after PR #29289, which removes all existing reqparse usage from the codebase.
Key changes:
- Enables the "TID" (flake8-tidy-imports) rule set in Ruff
- Configures banned-api rules to prevent future use of flask_restx.reqparse and flask_restx.reqparse.RequestParser
- Allows relative imports from parent modules by ignoring TID252
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Important
Fixes #<issue number>.Summary
after merging all of #29289 part, merge this.
Screenshots
Checklist
dev/reformat(backend) andcd web && npx lint-staged(frontend) to appease the lint gods